Skip to content

Robots Inside

Python project template - docs

ai 101 pytorch classification nvidia cuda install tensorrt yolo ardupilot None ros2 dds micro ros xrce sitl plugin SITL debug rangefinder pymavlink mavros gazebo distance sensor system_time timesync cmake gtest ctest cpp c++ format fmt multithreading spdlog camera coordinate system orb matching opencv build transformation computer vision homography optical flow of trackers cv cyclonedds eprosima fastdds simulation config ignition bridge sdf tips ign-transport sensors lidar aptly apt encryption pgp docker git bundle github hooks pre-commit lxd container lxc x11 profile vscode marpit presentation marp markdown mermaid video ffmpeg gstreamer cheat-sheet sdp v4l2loopback gi snippets cheat Sheet python asyncio future click cli numpy project template black isort docs project document docstrings flake8 linter git-hook mypy unittest pytest pylint mock iterator generator logging tuple namedtuple typing annotation pyzmq zmq msgpack action namespace remap control2 ros2_control gdb qos tag plugins msg node zero-copy shm tutorial algorithm calibration diff pid dev colcon colcon_cd rpi arm qemu settings behavior plot visualization debugging diagnostic diagnostics tutorials gst math apm rat_runtime_monitor web rosbridge vue binding discovery gazebo-classic launch spawn cook gps imu ray gazebo_ros_ray_sensor ultrsonic range ultrasonic gazebo classic wrench effort odom ign gz xacro ros_ign diff_drive odometry joint_state argument OpaqueFunction DeclareLaunchArgument LaunchConfiguration tmux nav slam test rclpy executor MultiThreadedExecutor SingleThreadedExecutor param dynamic-reconfigure service client setup.py package.xml parameter parameters custom msgs executers pub sub rqt rviz rviz2 pose marker tf2 deb package setup local_setup rosdep package manager project settings vcstool cross-compiler nano texture tmuxp rootfs embedded zah linux rm ubuntu ip ss network netstat snap deploy ssh systemd mkdocs extensions socat networking serial udp tc mtu select px4 robotics kalman_filter kalman filter control todo vscode-ext json yaml schema yocto poky world gazebo_ros2_control position_controller effort_controller velocity_controller urdf gazebo_ros_force gazebo_ros_joint_state_publisher robot_state_publisher joint_state_publisher projects vrx buoyancy

Python project template - docs

#python #project #template #docs #project document #docstrings

Table of Content

Python project template - docs#

Install#

pip install mkdocs-material
pip install mkdocstrings
pip install mkdocstrings-python
pip install mkdocs-click

Init docs#

Create docs folder
Create mkdocs.yml in project root

# from project root run
mkdocs new .

mkdocs.yml

site_name: My Docs
theme:
  name: "readthedocs"

plugins:
  - search
  - mkdocstrings

markdown_extensions:
    - mkdocs-click
watch:
  - .  # reload docs for any file changes

Simple Demo#

# Reference

::: my_library.my_module.my_class

index.md

::: demo_pkg.demo_module

demo_pkg.demo_module

"""
module doctring
"""
def foo() -> None:
    """_summary_
    """

def hello(a: List, b: int = 0) -> bool:
    """_summary_

    Args:
        a (List): _description_
        b (int, optional): _description_. Defaults to 0.

    Raises:
        Exception: _description_

    Returns:
        bool: _description_
    """
    print(a)
    print(b)
    if b:
        raise Exception("new demo exception")
    return True

VSCode#

Install and use autoDocstring extension

#

Reference#